topology.yml

YAML File	topology.yml
Loader Class	yaml.SafeLoader
Python Module	ng911ok.lib.topology
Python Variable	topology_config

The topology rules applied to the feature dataset(s) are specified in the topology.yml file.

YAML Structure

The root object is a mapping with the !TopologyConfig tag applied.

Top-Level Keys

exception_field	Field whose values indicate which features are exempt from certain topology rules.
exception_domain	Domain of exception_field.
required_dataset_topology_name	Name to be used for the topology in the required feature dataset.
optional_dataset_topology_name	Name to be used for the topology in the optional feature dataset.
required_dataset_rules	Sequence of mappings, each declaring a topology rule for the required feature dataset. Each entry should have a rule key set to an allowed value for the rule_type parameter of the arcpy.management.AddRuleToTopology function. Each entry should also have either a single member key or both member1 and member2 keys set to the role attribute(s) of feature class(es) subject to the rule.

Tags

Constructors are registered in ng911ok.lib.topology.

!TopologyConfig	Applied to the root mapping of topology.yml.
!FieldRole	Inserts the NG911Field instance with the role provided.
!DomainName	Inserts the NG911Domain instance with the name provided.

Anchors

No anchors are used in topology.yml.

Python Implementation

Warning

This section is incomplete.

The topology_config Variable

The module ng911ok.lib.topology provides the _NG911TopologyConfig class, which implements the !TopologyConfig tag, and its only instance, topology_config, which exposes the data stored in topology.yml.

Aliases

Important

The topology module defines aliases for selected members of topology_config. These aliases are used throughout the package to reduce the verbosity of the code. As top-level members of the module, they can be imported like so:

from ng911ok.lib.topology import RDST, ODST

:header-rows: 1

Alias	Referent	Type	Meaning
RDST	topology_config.required_dataset_topology_name	str	Required Dataset Topology
ODST	topology_config.optional_dataset_topology_name	str	Optional Dataset Topology

See also

topology.yml and Aliases